/*
 * Copyright ©2015-2021 Jaemon. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gitee.jaemon.spring.adorner.generator;

import io.gitee.jaemon.spring.adorner.core.AdornerApplicationContext;
import io.gitee.jaemon.spring.adorner.core.DocGenerator;
import io.gitee.jaemon.spring.adorner.exception.AdornerException;
import io.gitee.jaemon.spring.adorner.type.ApiDefinition;
import io.gitee.jaemon.spring.adorner.type.ParamPair;
import io.gitee.jaemon.spring.adorner.util.FreemarkerUtils;

import java.util.List;
import java.util.Map;


/**
 * freemark模板方式文档生成器
 *
 * @author Jaemon
 * @since 1.0
 */
public abstract class AbstractFreemarkGenerator implements DocGenerator<ParamPair> {
    @Override
    public void generate(List<ApiDefinition<ParamPair>> apiDefinitions, AdornerApplicationContext context) throws AdornerException {

        FreemarkerUtils.generate(
                context.filePath(),
                templateName(context),
                dataModel(apiDefinitions, context),
                basePackagePath(context)
        );
    }

    /**
     * 获取freemark填充数据
     *
     * @param apiDefinitions
     *          接口定义集合 {@link ApiDefinition}
     * @param context
     *          上下文对象
     * @return
     *          freemark填充数据
     */
    public abstract Map<String, Object> dataModel(List<ApiDefinition<ParamPair>> apiDefinitions, AdornerApplicationContext context);


    /**
     * 获取模板文件路径
     *
     * @param context
     *      上下文
     * @return
     *      模板文件路径
     */
    public String basePackagePath(AdornerApplicationContext context) {
        return "/adorner/template";
    }

    /**
     * 获取freemark模板名称
     *
     * @param context
     *      上下文
     * @return
     *      模板名称 {@link #basePackagePath(AdornerApplicationContext context)}/{@link #templateName(AdornerApplicationContext context)}
     */
    public String templateName(AdornerApplicationContext context) {
        return "AdornerFreemarkTemplate.ftl";
    }

}